org.eclipse.vtp.framework.spi
Interface IExecutionDescriptor

All Known Implementing Classes:

DeploymentExecution

public interface IExecutionDescriptor

A descriptor for process instances.

Author:

Lonnie Pryor

Method Summary

void	clearParameter(java.lang.String parameterName) Clears the value of the parameter with the specified name.
java.lang.String	getExecutionID() Returns the ID of the execution sequence being described.
java.lang.String	getParameter(java.lang.String parameterName) Returns the value of the parameter with the specified name or null if no such parameter exists.
java.lang.String[]	getParameterNames() Returns the names of the parameters available to the execution sequence.
java.lang.String[]	getParameters(java.lang.String parameterName) Returns the values of the parameter with the specified name or null if no such parameter exists.
java.lang.Object	getService(java.lang.String identifier) Returns the service selected for the specified identifier or null if no such service exists.
java.lang.String[]	getServiceIdentifiers() Returns the identifiers of all the externally-provided services.
void	setParameter(java.lang.String parameterName, java.lang.String value) Sets the value of the parameter with the specified name or clears it if the value is null.
void	setParameters(java.lang.String parameterName, java.lang.String[] values) Sets the values of the parameter with the specified name or clears them if the value is null or empty.

Method Detail

getExecutionID

java.lang.String getExecutionID()

Returns the ID of the execution sequence being described.

Returns:

The ID of the execution sequence being described.

getServiceIdentifiers

java.lang.String[] getServiceIdentifiers()

Returns the identifiers of all the externally-provided services.

Returns:

The identifiers of all the externally-provided services.

getService

java.lang.Object getService(java.lang.String identifier)
                            throws java.lang.NullPointerException

Returns the service selected for the specified identifier or null if no such service exists.

Parameters:

identifier - The identifier of the service to return.

Returns:

The service selected for the specified identifier or null if no such service exists.

Throws:

java.lang.NullPointerException - If the supplied identifier is null.

getParameterNames

java.lang.String[] getParameterNames()

Returns the names of the parameters available to the execution sequence.

Returns:

The names of the parameters available to the execution sequence.

getParameter

java.lang.String getParameter(java.lang.String parameterName)
                              throws java.lang.NullPointerException

Returns the value of the parameter with the specified name or null if no such parameter exists.

Parameters:

parameterName - The name of the parameter to return.

Returns:

The values of the parameter with the specified name or null if no such parameter exists.

Throws:

java.lang.NullPointerException - If the specified parameter name is null.

getParameters

java.lang.String[] getParameters(java.lang.String parameterName)
                                 throws java.lang.NullPointerException

Returns the values of the parameter with the specified name or null if no such parameter exists.

Parameters:

parameterName - The name of the parameter to return.

Returns:

The values of the parameter with the specified name or null if no such parameter exists.

Throws:

java.lang.NullPointerException - If the specified parameter name is null.

setParameter

void setParameter(java.lang.String parameterName,
                  java.lang.String value)
                  throws java.lang.NullPointerException

Sets the value of the parameter with the specified name or clears it if the value is null.

Parameters:

parameterName - The name of the parameter to set.

value - The value of the parameter with the specified name or null to clear the value.

Throws:

java.lang.NullPointerException - If the supplied parameter name is null.

setParameters

void setParameters(java.lang.String parameterName,
                   java.lang.String[] values)
                   throws java.lang.NullPointerException

Sets the values of the parameter with the specified name or clears them if the value is null or empty.

Parameters:

parameterName - The name of the parameters to set.

values - The values of the parameter with the specified name or null or to clear the values.

Throws:

java.lang.NullPointerException - If the supplied parameter name is null.

clearParameter

void clearParameter(java.lang.String parameterName)
                    throws java.lang.NullPointerException

Clears the value of the parameter with the specified name.

Parameters:

parameterName - The name of the parameter to clear.

Throws:

java.lang.NullPointerException - If the supplied parameter name is null.